<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__syspm__ppu__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__syspm.html">SysPm        (System Power Management)</a> &raquo; <a class="el" href="group__group__syspm__ppu.html">PPU (Power Policy Unit)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0ba1f63ed97b2f5fbd9511b21023ab0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#ga0ba1f63ed97b2f5fbd9511b21023ab0b">cy_pd_ppu_init</a> (struct ppu_v1_reg *ppu)</td></tr>
<tr class="memdesc:ga0ba1f63ed97b2f5fbd9511b21023ab0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the PD PPU Driver.  <a href="#ga0ba1f63ed97b2f5fbd9511b21023ab0b">More...</a><br /></td></tr>
<tr class="separator:ga0ba1f63ed97b2f5fbd9511b21023ab0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6a72751011421bd2e8e45e9c67827afd"><td class="memItemLeft" align="right" valign="top">enum ppu_v1_mode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#ga6a72751011421bd2e8e45e9c67827afd">cy_pd_ppu_get_programmed_power_mode</a> (struct ppu_v1_reg *ppu)</td></tr>
<tr class="memdesc:ga6a72751011421bd2e8e45e9c67827afd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the programmed power mode of the particular PPU.  <a href="#ga6a72751011421bd2e8e45e9c67827afd">More...</a><br /></td></tr>
<tr class="separator:ga6a72751011421bd2e8e45e9c67827afd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga474e0b1425c586dc40e836ac9e6985ab"><td class="memItemLeft" align="right" valign="top">enum ppu_v1_mode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#ga474e0b1425c586dc40e836ac9e6985ab">cy_pd_ppu_get_power_mode</a> (struct ppu_v1_reg *ppu)</td></tr>
<tr class="memdesc:ga474e0b1425c586dc40e836ac9e6985ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current power mode of the particular PPU.  <a href="#ga474e0b1425c586dc40e836ac9e6985ab">More...</a><br /></td></tr>
<tr class="separator:ga474e0b1425c586dc40e836ac9e6985ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadfa3c02cbe77ad372bb9c7c9c5e4024f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#gadfa3c02cbe77ad372bb9c7c9c5e4024f">cy_pd_ppu_set_power_mode</a> (struct ppu_v1_reg *ppu, uint32_t <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:gadfa3c02cbe77ad372bb9c7c9c5e4024f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the required power mode of the particular PPU.  <a href="#gadfa3c02cbe77ad372bb9c7c9c5e4024f">More...</a><br /></td></tr>
<tr class="separator:gadfa3c02cbe77ad372bb9c7c9c5e4024f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffe58c158c69c47fce5e1130497f6fbd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#gaffe58c158c69c47fce5e1130497f6fbd">cy_pd_ppu_enable_dynamic_mode</a> (struct ppu_v1_reg *ppu, bool enable)</td></tr>
<tr class="memdesc:gaffe58c158c69c47fce5e1130497f6fbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables/Disable Dynamic Mode of particular PPU.  <a href="#gaffe58c158c69c47fce5e1130497f6fbd">More...</a><br /></td></tr>
<tr class="separator:gaffe58c158c69c47fce5e1130497f6fbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0c77c7391189f11074d3f83c26168f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#gad0c77c7391189f11074d3f83c26168f0">cy_pd_ppu_set_static_power_mode</a> (struct ppu_v1_reg *ppu, uint32_t <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:gad0c77c7391189f11074d3f83c26168f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the required static power mode of the particular PPU.  <a href="#gad0c77c7391189f11074d3f83c26168f0">More...</a><br /></td></tr>
<tr class="separator:gad0c77c7391189f11074d3f83c26168f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7fce14f1a71df1fc7f00cd3da46f4418"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#ga7fce14f1a71df1fc7f00cd3da46f4418">cy_pd_ppu_reset</a> (struct ppu_v1_reg *ppu)</td></tr>
<tr class="memdesc:ga7fce14f1a71df1fc7f00cd3da46f4418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the PD using PPU.  <a href="#ga7fce14f1a71df1fc7f00cd3da46f4418">More...</a><br /></td></tr>
<tr class="separator:ga7fce14f1a71df1fc7f00cd3da46f4418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d0ef7dbbc00c8f155edb4e81c24d919"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__ppu__enums.html#ga21be6250f3d38612ce8cf08d37b09741">cy_pd_ppu_device_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__ppu__functions.html#ga5d0ef7dbbc00c8f155edb4e81c24d919">cy_pd_ppu_get_ds_fail_device</a> (struct ppu_v1_reg *ppu)</td></tr>
<tr class="memdesc:ga5d0ef7dbbc00c8f155edb4e81c24d919"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the PPU's device ID(s) which caused the Deepsleep Failure.  <a href="#ga5d0ef7dbbc00c8f155edb4e81c24d919">More...</a><br /></td></tr>
<tr class="separator:ga5d0ef7dbbc00c8f155edb4e81c24d919"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga0ba1f63ed97b2f5fbd9511b21023ab0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ba1f63ed97b2f5fbd9511b21023ab0b">&#9670;&nbsp;</a></span>cy_pd_ppu_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> cy_pd_ppu_init </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the PD PPU Driver. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the PD PPU API status <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>. </dd></dl>

</div>
</div>
<a id="ga6a72751011421bd2e8e45e9c67827afd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6a72751011421bd2e8e45e9c67827afd">&#9670;&nbsp;</a></span>cy_pd_ppu_get_programmed_power_mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum ppu_v1_mode cy_pd_ppu_get_programmed_power_mode </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the programmed power mode of the particular PPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the PPU Programmed Power mode </dd></dl>

</div>
</div>
<a id="ga474e0b1425c586dc40e836ac9e6985ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga474e0b1425c586dc40e836ac9e6985ab">&#9670;&nbsp;</a></span>cy_pd_ppu_get_power_mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum ppu_v1_mode cy_pd_ppu_get_power_mode </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the current power mode of the particular PPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the PPU Current Power mode </dd></dl>

</div>
</div>
<a id="gadfa3c02cbe77ad372bb9c7c9c5e4024f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadfa3c02cbe77ad372bb9c7c9c5e4024f">&#9670;&nbsp;</a></span>cy_pd_ppu_set_power_mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> cy_pd_ppu_set_power_mode </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the required power mode of the particular PPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
    <tr><td class="paramname">mode</td><td>Contains the future power mode to be set for the PPU.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the PD PPU API status <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>. </dd></dl>

</div>
</div>
<a id="gaffe58c158c69c47fce5e1130497f6fbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaffe58c158c69c47fce5e1130497f6fbd">&#9670;&nbsp;</a></span>cy_pd_ppu_enable_dynamic_mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cy_pd_ppu_enable_dynamic_mode </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables/Disable Dynamic Mode of particular PPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
    <tr><td class="paramname">enable</td><td>true - Enables the Dynamic mode for the PD. false - Disables the Dynamic mode for the PD. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gad0c77c7391189f11074d3f83c26168f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad0c77c7391189f11074d3f83c26168f0">&#9670;&nbsp;</a></span>cy_pd_ppu_set_static_power_mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> cy_pd_ppu_set_static_power_mode </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the required static power mode of the particular PPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
    <tr><td class="paramname">mode</td><td>Contains the future power mode to be set for the PPU.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the PD PPU API status <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>. </dd></dl>

</div>
</div>
<a id="ga7fce14f1a71df1fc7f00cd3da46f4418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7fce14f1a71df1fc7f00cd3da46f4418">&#9670;&nbsp;</a></span>cy_pd_ppu_reset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> cy_pd_ppu_reset </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resets the PD using PPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the PD PPU API status <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>. </dd></dl>

</div>
</div>
<a id="ga5d0ef7dbbc00c8f155edb4e81c24d919"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d0ef7dbbc00c8f155edb4e81c24d919">&#9670;&nbsp;</a></span>cy_pd_ppu_get_ds_fail_device()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__ppu__enums.html#ga21be6250f3d38612ce8cf08d37b09741">cy_pd_ppu_device_status_t</a> cy_pd_ppu_get_ds_fail_device </td>
          <td>(</td>
          <td class="paramtype">struct ppu_v1_reg *&#160;</td>
          <td class="paramname"><em>ppu</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the PPU's device ID(s) which caused the Deepsleep Failure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppu</td><td>This parameter contains PPU base pointer for which the initialization has to be done.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the PPU's device ID which caused the Deepsleep Failure </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
